Catalogue d'API
Documentation API
Présentation de l'API
L' Cargo Insurance offre une intégration transparente pour obtenir une couverture d'assurance cargo en ligne. Grâce à cette API, les utilisateurs peuvent gérer et assurer efficacement leurs expéditions, garantissant ainsi une tranquillité d'esprit et une protection financière contre les pertes potentielles pendant le transport. L'API est accessible via une requête POST vers deux URL de base, une pour la préparation et une autre pour la production qui sont indiquées ci-dessous, et nécessite une authentification via les en-têtes api_key et api_sec , celles-ci vous seront fournies par l'administrateur. Cette approche rationalisée permet un traitement d’assurance rapide et sécurisé, adapté aux besoins des opérations logistiques modernes.
URL de base : https://cargoinsureonline.com/wp-json/api/v2
En-têtes API :
api_key : API_KEY
api_sec : API_SEC
Obtenez toutes les options d'assurance
L'API Get All Insurance options vous offre toutes les options telles que les pays, les types de groupe, les types de risque, les types de transport et les devises que vous devez sélectionner lors de l'achat d'une nouvelle assurance.
Point final : /get-cargo-insurance-options
Méthode API : GET
curl –location –request GET 'https://cargoinsureonline.com/wp-json/api/v2/get-cargo-insurance-options' \
–header 'api_key : API_KEY ' \
–header 'api_sec : API_SEC'
Obtenez tous les pays
L’API des options Get All Countries vous fournit une liste de pays essentiels aux processus internationaux de logistique et d’assurance.
Point final : / get-cargo-insurance-options ?type=countries
Méthode API : GET
curl –location –request GET 'https://cargoinsureonline.com/wp-json/api/v2/get-cargo-insurance-options?type=countries' \
–header 'api_key : API_KEY ' \
–header 'api_sec : API_SEC '
Obtenez tous les types de groupes
L'API Get All Group Types vous fournit la liste de tous les types de groupes dans lesquels votre cargaison appartient comme le commerce électronique, les œuvres d'art, les marchandises générales, etc.
Point final : / get-cargo-insurance-options ?type=group_types
Méthode API : GET
curl –location –request GET 'https://cargoinsureonline.com/wp-json/api/v2/ get-cargo-insurance-options ?type=group_types' \
–en-tête 'api_key : API_KEY' \
–en-tête 'api_sec : API_SEC'
Obtenez tous les types de risques
L'API Get All Risk Types vous donne une liste de tous les risques auxquels votre cargaison peut être soumise selon vous.
Point final : /g et-cargo-insurance-options ?type=risk_types
Méthode API : GET
curl –location –request GET 'https://cargoinsureonline.com/wp-json/api/v2/ get-cargo-insurance-options ?type=risk_types' \
–en-tête 'api_key : API_KEY' \
–en-tête 'api_sec : API_SEC'
Obtenez tous les types de transport
L'API Get All Transport Types vous donne la liste de tous les modes de transport que votre marchandise peut emprunter comme AIR, MER, ROUTE, COURRIER, etc.
Point final : / get-cargo-insurance-options ?type=transport_types
Méthode API : GET
–en-tête 'api_key : API_KEY' \
–en-tête 'api_sec : API_SEC'
Obtenez toutes les devises
L'API Get All Currencies fournit aux utilisateurs une liste détaillée des devises mondiales, essentielles au commerce international et aux transactions financières.
Point final : / get-cargo-insurance-options ?type=currencies
Méthode API : GET
curl –location –request GET 'https://cargoinsureonline.com/wp-json/api/v2/ get-cargo-insurance-options ?type=currencies' \
–en-tête 'api_key : API_KEY' \
–en-tête 'api_sec : API_SEC'
Obtenez tous les transporteurs
L'API Get All Carriers fournit une liste de tous les transporteurs utilisés par la plupart des clients comme Chronopost, DHL, FedEx, UPS, etc.
Point final : / get-cargo-insurance-options ?type=carriers
Méthode API : GET
curl –location –request GET 'https://cargoinsureonline.com/wp-json/api/v2/ get-cargo-insurance-options ?type=currencies' \
–en-tête 'api_key : API_KEY' \
–en-tête 'api_sec : API_SEC'
Souscrire une assurance marchandises
L'API Buy Insurance permet aux utilisateurs de souscrire efficacement une assurance fret pour leurs expéditions. En accédant au point de terminaison /buy-cargo-insurance , les utilisateurs peuvent envoyer une demande POST avec des informations détaillées sur l'expédition et le client pour obtenir la couverture d'assurance nécessaire. Cette API rationalise le processus d'obtention d'une assurance cargo, garantissant une protection rapide et précise des expéditions.
Point final : /acheter-cargo-assurance
Obtenez le taux d’assurance du fret
Vous pouvez utiliser cette API pour obtenir les tarifs d'assurance sans l'acheter. Il accepte toutes les données de la même manière que l'achat d'une assurance-cargo et ne renvoie que les détails de l'assurance au prix le plus bas.
Point final : /get-cargo-insurance-rates
Obtenez des informations sur les réclamations pour n’importe quel utilisateur
L'API Obtenir toutes les informations sur les réclamations renverra tous les détails, la valeur de la réclamation, les documents, etc. Elle sera basée sur la clé API et les en-têtes secrets API utilisés dans l'appel API.
Point de terminaison : /get-claims-by-user-id
Méthode API : GET
Exemple de réponse :
[{
"id": "1",
"user_id": "101",
"policy_number": "A123",
"company_name": "Example Insurance Co.", "
contact_name": "John Doe",
"email": "johndoe@example.com",
"téléphone" : "1234567890",
"claim_value" : "500.00",
"date_of_loss" : « 01/01/2024 »,
« description » : « Exemple de description de revendication »,
« documents » : « a:2:{i:0;s:94:\ »https://example.com/files/sample- image1.png\";i:1;s:88:\"https://example.com/files/sample-document1.pdf\";}",
"statut": "En cours de révision",
« remarques » : « Vérification en cours »,
« claim_date » : « 2024-01-02 10:00:00 »
}]
curl –location –request GET 'https://cargoinsureonline.com/wp-json/api/v2/get-claims-by-user-id' \
–header 'api_key : API_KEY ' \
–header 'api_sec : API_SEC'